home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / librw / RWSequenceable.z / RWSequenceable
Encoding:
Text File  |  2002-10-03  |  4.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee((((3333CCCC++++++++))))                                      RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWSequenceable - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               #include <rw/seqcltn.h>
  13.  
  14.  
  15.  
  16.               typedef RWSequenceable SequenceableCollection;
  17.                         // Smalltalk typedef
  18.  
  19.  
  20.  
  21.  
  22. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  23.      Class RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee is an abstract base class for collections that can
  24.      be accessed by an index.  It inherits class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn as a public base
  25.      class and adds a few extra virtual functions.  This documentation only
  26.      describes these extra functions.
  27.  
  28. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  29.      Polymorphic
  30.  
  31.  
  32.  
  33.  
  34.  
  35. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  36.               RWCollectable*
  37.           aaaappppppppeeeennnndddd(RWCollectable*) = 0;
  38.  
  39.  
  40.      Adds the item to the end of the collection and returns it.  Returns nnnniiiillll
  41.      if the insertion was unsuccessful.
  42.  
  43.               virtual RWCollectable*&
  44.           aaaatttt(size_t i);
  45.           virtual const RWCollectable*
  46.           aaaatttt(size_t i) const;
  47.  
  48.  
  49.      Allows access to the iiiith element of the collection.  The first variant
  50.      can be used as an lvalue, the second cannot.  The index iiii must be between
  51.      zero and the number of items in the collection less one, or an exception
  52.      of type RRRRWWWWBBBBoooouuuunnnnddddssssEEEErrrrrrrr will be thrown.
  53.  
  54.               virtual RWCollectable*
  55.           ffffiiiirrrrsssstttt() const = 0;
  56.  
  57.  
  58.      Returns the first item in the collection.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee((((3333CCCC++++++++))))                                      RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.               virtual size_t
  75.           iiiinnnnddddeeeexxxx(const RWCollectable* c) const = 0;
  76.  
  77.  
  78.      Returns the index number of the first item that "matches" the item
  79.      pointed to by cccc.  If there is no such item, returns RRRRWWWW____NNNNPPPPOOOOSSSS.  For most
  80.      collections, an item "matches" the target if either iiiissssEEEEqqqquuuuaaaallll(((()))) or
  81.      ccccoooommmmppppaaaarrrreeeeTTTToooo(((()))) find equivalence, whichever is appropriate for the actual
  82.      collection type.
  83.  
  84.               void
  85.           iiiinnnnsssseeeerrrrttttAAAAtttt(size_t indx, RWCollectable* e);
  86.  
  87.  
  88.      Adds a new item to the collection at position iiiinnnnddddxxxx.  The item previously
  89.      at position iiii is moved to iiii++++1111, etc.  The index iiiinnnnddddxxxx must be between 0 and
  90.      the number of items in the collection, or an exception of type
  91.      RRRRWWWWBBBBoooouuuunnnnddddssssEEEErrrrrrrr will be thrown.
  92.  
  93.               virtual RWCollectable*
  94.           llllaaaasssstttt() const = 0;
  95.  
  96.  
  97.      Returns the last item in the collection.
  98.  
  99.               RWCollectable*
  100.           pppprrrreeeeppppeeeennnndddd(RWCollectable*) = 0;
  101.  
  102.  
  103.      Adds the item to the beginning of the collection and returns it.  Returns
  104.      nnnniiiillll if the insertion was unsuccessful.
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.